home *** CD-ROM | disk | FTP | other *** search
mmmmeeeennnnuuuu((((nnnn)))) TTTTkkkk (((( )))) mmmmeeeennnnuuuu((((nnnn)))) _________________________________________________________________ NNNNAAAAMMMMEEEE menu - Create and manipulate menu widgets SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS mmmmeeeennnnuuuu _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s? SSSSTTTTAAAANNNNDDDDAAAARRRRDDDD OOOOPPPPTTTTIIIIOOOONNNNSSSS aaaaccccttttiiiivvvveeeeBBBBaaaacccckkkkggggrrrroooouuuunnnndddd bbbbaaaacccckkkkggggrrrroooouuuunnnndddd ddddiiiissssaaaabbbblllleeeeddddFFFFoooorrrreeeeggggrrrroooouuuunnnndddd| aaaaccccttttiiiivvvveeeeBBBBoooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh bbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh ffffoooonnnntttt | aaaaccccttttiiiivvvveeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd ccccuuuurrrrssssoooorrrr ffffoooorrrreeeeggggrrrroooouuuunnnndddd | See the ``options'' manual entry for details on the standard options. WWWWIIIIDDDDGGGGEEEETTTT----SSSSPPPPEEEECCCCIIIIFFFFIIIICCCC OOOOPPPPTTTTIIIIOOOONNNNSSSS Name: ppppoooossssttttCCCCoooommmmmmmmaaaannnndddd Class: CCCCoooommmmmmmmaaaannnndddd | Command-Line Switch:----ppppoooossssttttccccoooommmmmmmmaaaannnndddd | || If this option is specified then it provides a Tcl | command to execute each time the menu is posted. The | command is invoked by the ppppoooosssstttt widget command before | posting the menu. Name: sssseeeelllleeeeccccttttoooorrrr Class: FFFFoooorrrreeeeggggrrrroooouuuunnnndddd Command-Line Switch:----sssseeeelllleeeeccccttttoooorrrr For menu entries that are check buttons or radio buttons, this option specifies the color to display in the selector when the check button or radio button is selected. _________________________________________________________________ IIIINNNNTTTTRRRROOOODDDDUUUUCCCCTTTTIIIIOOOONNNN The mmmmeeeennnnuuuu command creates a new top-level window (given by the _p_a_t_h_N_a_m_e argument) and makes it into a menu widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the menu such as its colors and font. The mmmmeeeennnnuuuu command returns its _p_a_t_h_N_a_m_e argument. At the time this command is invoked, there must not exist a window named _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent must exist. A menu is a widget that displays a collection of one-line entries arranged in a column. There exist several different types of entries, each with different properties. Entries of different types may be combined in a single menu. Menu Page 1 (printed 7/23/95) mmmmeeeennnnuuuu((((nnnn)))) TTTTkkkk (((( )))) mmmmeeeennnnuuuu((((nnnn)))) entries are not the same as entry widgets. In fact, menu entries are not even distinct widgets; the entire menu is one widget. Menu entries are displayed with up to three separate fields. The main field is a label in the form of text or a bitmap, which is determined by the ----llllaaaabbbbeeeellll or ----bbbbiiiittttmmmmaaaapppp option for the entry. If the ----aaaacccccccceeeelllleeeerrrraaaattttoooorrrr option is specified for an entry then a second textual field is displayed to the right of the label. The accelerator typically describes a keystroke sequence that may be typed in the application to cause the same result as invoking the menu entry. The third field is a _s_e_l_e_c_t_o_r. The selector is present only for check-button or radio-button entries. It indicates whether the entry is selected or not, and is displayed to the left of the entry's string. In normal use, an entry becomes active (displays itself differently) whenever the mouse pointer is over the entry. If a mouse button is released over the entry then the entry is _i_n_v_o_k_e_d. The effect of invocation is different for each type of entry; these effects are described below in the sections on individual entries. Entries may be _d_i_s_a_b_l_e_d, which causes their labels and accelerators to be displayed with dimmer colors. A disabled entry cannot be activated or invoked. Disabled entries may be re-enabled, at which point it becomes possible to activate and invoke them again. CCCCOOOOMMMMMMMMAAAANNNNDDDD EEEENNNNTTTTRRRRIIIIEEEESSSS The most common kind of menu entry is a command entry, which behaves much like a button widget. When a command entry is invoked, a Tcl command is executed. The Tcl command is specified with the ----ccccoooommmmmmmmaaaannnndddd option. SSSSEEEEPPPPAAAARRRRAAAATTTTOOOORRRR EEEENNNNTTTTRRRRIIIIEEEESSSS A separator is an entry that is displayed as a horizontal dividing line. A separator may not be activated or invoked, and it has no behavior other than its display appearance. CCCCHHHHEEEECCCCKKKK----BBBBUUUUTTTTTTTTOOOONNNN EEEENNNNTTTTRRRRIIIIEEEESSSS A check-button menu entry behaves much like a check-button widget. When it is invoked it toggles back and forth between the selected and deselected states. When the entry is selected, a particular value is stored in a particular global variable (as determined by the ----oooonnnnvvvvaaaalllluuuueeee and ----vvvvaaaarrrriiiiaaaabbbblllleeee options for the entry); when the entry is deselected another value (determined by the ----ooooffffffffvvvvaaaalllluuuueeee option) is stored Page 2 (printed 7/23/95) mmmmeeeennnnuuuu((((nnnn)))) TTTTkkkk (((( )))) mmmmeeeennnnuuuu((((nnnn)))) in the global variable. A selector box is displayed to the left of the label in a check-button entry. If the entry is selected then the box's center is displayed in the color given by the sssseeeelllleeeeccccttttoooorrrr option for the menu; otherwise the box's center is displayed in the background color for the menu. If a ----ccccoooommmmmmmmaaaannnndddd option is specified for a check-button entry, then its value is evaluated as a Tcl command each time the entry is invoked; this happens after toggling the entry's selected state. RRRRAAAADDDDIIIIOOOO----BBBBUUUUTTTTTTTTOOOONNNN EEEENNNNTTTTRRRRIIIIEEEESSSS A radio-button menu entry behaves much like a radio-button widget. Radio-button entries are organized in groups of which only one entry may be selected at a time. Whenever a particular entry becomes selected it stores a particular value into a particular global variable (as determined by the ----vvvvaaaalllluuuueeee and ----vvvvaaaarrrriiiiaaaabbbblllleeee options for the entry). This action causes any previously-selected entry in the same group to deselect itself. Once an entry has become selected, any change to the entry's associated variable will cause the entry to deselect itself. Grouping of radio- button entries is determined by their associated variables: if two entries have the same associated variable then they are in the same group. A selector diamond is displayed to the left of the label in each radio-button entry. If the entry is selected then the diamond's center is displayed in the color given by the sssseeeelllleeeeccccttttoooorrrr option for the menu; otherwise the diamond's center is displayed in the background color for the menu. If a ----ccccoooommmmmmmmaaaannnndddd option is specified for a radio-button entry, then its value is evaluated as a Tcl command each time the entry is invoked; this happens after selecting the entry. CCCCAAAASSSSCCCCAAAADDDDEEEE EEEENNNNTTTTRRRRIIIIEEEESSSS A cascade entry is one with an associated menu (determined by the ----mmmmeeeennnnuuuu option). Cascade entries allow the construction of cascading menus. When the entry is activated, the associated menu is posted just to the right of the entry; that menu remains posted until the higher- level menu is unposted or until some other entry is activated in the higher-level menu. The associated menu should normally be a child of the menu containing the cascade entry, in order for menu traversal to work correctly. A cascade entry posts its associated menu by invoking a Tcl command of the form _m_e_n_u ppppoooosssstttt _x _y Page 3 (printed 7/23/95) mmmmeeeennnnuuuu((((nnnn)))) TTTTkkkk (((( )))) mmmmeeeennnnuuuu((((nnnn)))) where _m_e_n_u is the path name of the associated menu, _x and _y are the root-window coordinates of the upper-right corner of the cascade entry, and _g_r_o_u_p is the name of the menu's group (as determined in its last ppppoooosssstttt widget command). The lower-level menu is unposted by executing a Tcl command with the form _m_e_n_u uuuunnnnppppoooosssstttt where _m_e_n_u is the name of the associated menu. If a ----ccccoooommmmmmmmaaaannnndddd option is specified for a cascade entry then it is evaluated as a Tcl command each time the associated | menu is posted (the evaluation occurs before the menu is | posted). WWWWIIIIDDDDGGGGEEEETTTT CCCCOOOOMMMMMMMMAAAANNNNDDDD The mmmmeeeennnnuuuu command creates a new Tcl command whose name is _p_a_t_h_N_a_m_e. This command may be used to invoke various operations on the widget. It has the following general form: _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...? _O_p_t_i_o_n and the _a_r_gs determine the exact behavior of the command. Many of the widget commands for a menu take as one argument an indicator of which entry of the menu to operate on. These indicators are called _i_n_d_e_xes and may be specified in any of the following forms: _n_u_m_b_e_r Specifies the entry numerically, where 0 corresponds to the top-most entry of the menu, 1 to the entry below it, and so on. aaaaccccttttiiiivvvveeee Indicates the entry that is currently active. If no entry is active then this form is equivalent to nnnnoooonnnneeee. This form may not be abbreviated. llllaaaasssstttt Indicates the bottommost entry in the menu. If there are no entries in the menu then this form is equivalent to nnnnoooonnnneeee. This form may not be abbreviated. nnnnoooonnnneeee Indicates ``no entry at all''; this is used most commonly with the aaaaccccttttiiiivvvvaaaatttteeee option to deactivate all the entries in the menu. In most cases the specification of nnnnoooonnnneeee causes nothing to happen in the widget command. This form may not be abbreviated. Page 4 (printed 7/23/95) mmmmeeeennnnuuuu((((nnnn)))) TTTTkkkk (((( )))) mmmmeeeennnnuuuu((((nnnn)))) @@@@_n_u_m_b_e_r In this form, _n_u_m_b_e_r is treated as a y- coordinate in the menu's window; the entry spanning that y-coordinate is used. For example, ``@@@@0000'' indicates the top-most entry in the window. If _n_u_m_b_e_r is outside the range of the window then this form is equivalent to nnnnoooonnnneeee. _p_a_t_t_e_r_n If the index doesn't satisfy one of the above forms then this form is used. _P_a_t_t_e_r_n is pattern-matched against the label of each entry in the menu, in order from the top down, until a matching entry is found. The rules of TTTTccccllll____SSSSttttrrrriiiinnnnggggMMMMaaaattttcccchhhh are used. The following widget commands are possible for menu widgets: _p_a_t_h_N_a_m_e aaaaccccttttiiiivvvvaaaatttteeee _i_n_d_e_x Change the state of the entry indicated by _i_n_d_e_x to aaaaccccttttiiiivvvveeee and redisplay it using its active colors. Any previously-active entry is deactivated. If _i_n_d_e_x is specified as nnnnoooonnnneeee, or if the specified entry is disabled, then the menu ends up with no active entry. Returns an empty string. _p_a_t_h_N_a_m_e aaaadddddddd _t_y_p_e ?_o_p_t_i_o_n _v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...? Add a new entry to the bottom of the menu. The new entry's type is given by _t_y_p_e and must be one of ccccaaaassssccccaaaaddddeeee, cccchhhheeeecccckkkkbbbbuuuuttttttttoooonnnn, ccccoooommmmmmmmaaaannnndddd, rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn, or sssseeeeppppaaaarrrraaaattttoooorrrr, or a unique abbreviation of one of the above. If additional arguments are present, they specify any of the following options: ----aaaaccccttttiiiivvvveeeebbbbaaaacccckkkkggggrrrroooouuuunnnndddd _v_a_l_u_e Specifies a background color to use for displaying | this entry when it is active. If this option is | specified as an empty string (the default), then | the aaaaccccttttiiiivvvveeeeBBBBaaaacccckkkkggggrrrroooouuuunnnndddd option for the overall menu | is used. This option is not available for | separator entries. ----aaaacccccccceeeelllleeeerrrraaaattttoooorrrr _v_a_l_u_e Specifies a string to display at the right side of the menu entry. Normally describes an accelerator keystroke sequence that may be typed to invoke the same function as the menu entry. This option is not available for separator entries. ----bbbbaaaacccckkkkggggrrrroooouuuunnnndddd _v_a_l_u_e Specifies a background color to use for displaying | this entry when it is in the normal state (neither | active nor disabled). If this option is specified | as an empty string (the default), then the | Page 5 (printed 7/23/95) mmmmeeeennnnuuuu((((nnnn)))) TTTTkkkk (((( )))) mmmmeeeennnnuuuu((((nnnn)))) bbbbaaaacccckkkkggggrrrroooouuuunnnndddd option for the overall menu is used. | This option is not available for separator | entries. ----bbbbiiiittttmmmmaaaapppp _v_a_l_u_e Specifies a bitmap to display in the menu instead of a textual label, in any of the forms accepted by TTTTkkkk____GGGGeeeettttBBBBiiiittttmmmmaaaapppp. This option overrides the ----llllaaaabbbbeeeellll option but may be reset to an empty string to enable a textual label to be displayed. This option is not available for separator entries. ----ccccoooommmmmmmmaaaannnndddd _v_a_l_u_e For command, checkbutton, and radiobutton entries, specifies a Tcl command to execute when the menu | entry is invoked. For cascade entries, specifies | a Tcl command to execute when the entry is | activated (i.e. just before its submenu is | posted). Not available for separator entries. ----ffffoooonnnntttt _v_a_l_u_e Specifies the font to use when drawing the label | or accelerator string in this entry. If this | option is specified as an empty string (the | default) then the ffffoooonnnntttt option for the overall menu | is used. This option is not available for | separator entries. ----llllaaaabbbbeeeellll _v_a_l_u_e Specifies a string to display as an identifying label in the menu entry. Not available for separator entries. ----mmmmeeeennnnuuuu _v_a_l_u_e Available only for cascade entries. Specifies the path name of the menu associated with this entry. ----ooooffffffffvvvvaaaalllluuuueeee _v_a_l_u_e Available only for check-button entries. Specifies the value to store in the entry's associated variable when the entry is deselected. ----oooonnnnvvvvaaaalllluuuueeee _v_a_l_u_e Available only for check-button entries. Specifies the value to store in the entry's associated variable when the entry is selected. ----ssssttttaaaatttteeee _v_a_l_u_e Specifies one of three states for the entry: | nnnnoooorrrrmmmmaaaallll, aaaaccccttttiiiivvvveeee, or ddddiiiissssaaaabbbblllleeeedddd. In normal state the | entry is displayed using the ffffoooorrrreeeeggggrrrroooouuuunnnndddd option for | the menu and the bbbbaaaacccckkkkggggrrrroooouuuunnnndddd option from the entry | Page 6 (printed 7/23/95) mmmmeeeennnnuuuu((((nnnn)))) TTTTkkkk (((( )))) mmmmeeeennnnuuuu((((nnnn)))) or the menu. The active state is typically used | when the pointer is over the entry. In active | state the entry is displayed using the | aaaaccccttttiiiivvvveeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd option for the menu along with | the aaaaccccttttiiiivvvveeeebbbbaaaacccckkkkggggrrrroooouuuunnnndddd option from the entry. | Disabled state means that the entry is | insensitive: it doesn't activate and doesn't | respond to mouse button presses or releases. In | this state the entry is displayed according to the | ddddiiiissssaaaabbbblllleeeeddddFFFFoooorrrreeeeggggrrrroooouuuunnnndddd option for the menu and the | bbbbaaaacccckkkkggggrrrroooouuuunnnndddd option from the entry. This option is | not available for separator entries. | ----uuuunnnnddddeeeerrrrlllliiiinnnneeee _v_a_l_u_e || Specifies the integer index of a character to | underline in the entry. This option is typically | used to indicate keyboard traversal characters. 0 | corresponds to the first character of the text | displayed in the entry, 1 to the next character, | and so on. If a bitmap is displayed in the entry | then this option is ignored. This option is not | available for separator entries. ----vvvvaaaalllluuuueeee _v_a_l_u_e Available only for radio-button entries. Specifies the value to store in the entry's associated variable when the entry is selected. ----vvvvaaaarrrriiiiaaaabbbblllleeee _v_a_l_u_e Available only for check-button and radio-button entries. Specifies the name of a global value to set when the entry is selected. For check-button entries the variable is also set when the entry is deselected. For radio-button entries, changing the variable causes the currently-selected entry to deselect itself. The aaaadddddddd widget command returns an empty string. _p_a_t_h_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...? Query or modify the configuration options of the widget. If no _o_p_t_i_o_n is specified, returns a list describing all of the available options for _p_a_t_h_N_a_m_e (see TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the format of this list). If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no _o_p_t_i_o_n is specified). If one or more _o_p_t_i_o_n-_v_a_l_u_e pairs are specified, then the command modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. _O_p_t_i_o_n Page 7 (printed 7/23/95) mmmmeeeennnnuuuu((((nnnn)))) TTTTkkkk (((( )))) mmmmeeeennnnuuuu((((nnnn)))) may have any of the values accepted by the mmmmeeeennnnuuuu command. _p_a_t_h_N_a_m_e ddddeeeelllleeeetttteeee _i_n_d_e_x_1 ?_i_n_d_e_x_2? Delete all of the menu entries between _i_n_d_e_x_1 and | _i_n_d_e_x_2 inclusive. If _i_n_d_e_x_2 is omitted then it | defaults to _i_n_d_e_x_1. Returns an empty string. _p_a_t_h_N_a_m_e ddddiiiissssaaaabbbblllleeee _i_n_d_e_x Change the state of the entry given by _i_n_d_e_x to | ddddiiiissssaaaabbbblllleeeedddd and redisplay the entry using its disabled | colors. Returns an empty string. This command is | obsolete and will eventually be removed; use ``_p_a_t_h_N_a_m_e | eeeennnnttttrrrryyyyccccoooonnnnffffiiiigggguuuurrrreeee _i_n_d_e_x -state disabled'' instead. _p_a_t_h_N_a_m_e eeeennnnaaaabbbblllleeee _i_n_d_e_x Change the state of the entry given by _i_n_d_e_x to nnnnoooorrrrmmmmaaaallll | and redisplay the entry using its normal colors. | Returns an empty string. This command is obsolete and | will eventually be removed; use ``_p_a_t_h_N_a_m_e | eeeennnnttttrrrryyyyccccoooonnnnffffiiiigggguuuurrrreeee _i_n_d_e_x -state normal'' instead. _p_a_t_h_N_a_m_e eeeennnnttttrrrryyyyccccoooonnnnffffiiiigggguuuurrrreeee _i_n_d_e_x ?_o_p_t_i_o_n_s? This command is similar to the ccccoooonnnnffffiiiigggguuuurrrreeee command, except that it applies to the options for an individual entry, whereas ccccoooonnnnffffiiiigggguuuurrrreeee applies to the options for the menu as a whole. _O_p_t_i_o_n_s may have any of the values accepted by the aaaadddddddd widget command. If _o_p_t_i_o_n_s are specified, options are modified as indicated in the command and the command returns an empty string. If no _o_p_t_i_o_n_s are specified, returns a list describing the current options for entry _i_n_d_e_x (see TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the format of this list). _p_a_t_h_N_a_m_e iiiinnnnddddeeeexxxx _i_n_d_e_x Returns the numerical index corresponding to _i_n_d_e_x, or nnnnoooonnnneeee if _i_n_d_e_x was specified as nnnnoooonnnneeee. _p_a_t_h_N_a_m_e iiiinnnnvvvvooookkkkeeee _i_n_d_e_x Invoke the action of the menu entry. See the sections on the individual entries above for details on what happens. If the menu entry is disabled then nothing happens. If the entry has a command associated with it then the result of that command is returned as the result of the iiiinnnnvvvvooookkkkeeee widget command. Otherwise the result is an empty string. Note: invoking a menu entry does not automatically unpost the menu. Normally the associated menubutton will take care of unposting the menu. _p_a_t_h_N_a_m_e ppppoooosssstttt _x _y Arrange for the menu to be displayed on the screen at Page 8 (printed 7/23/95) mmmmeeeennnnuuuu((((nnnn)))) TTTTkkkk (((( )))) mmmmeeeennnnuuuu((((nnnn)))) the root-window coordinates given by _x and _y. These coordinates are adjusted if necessary to guarantee that the entire menu is visible on the screen. This command normally returns an empty string. If the ----ppppoooossssttttccccoooommmmmmmmaaaannnndddd | option has been specified, then its value is executed | as a Tcl script before posting the menu and the result | of that script is returned as the result of the ppppoooosssstttt | widget command. If an error returns while executing | the command, then the error is returned without posting | the menu. _p_a_t_h_N_a_m_e uuuunnnnppppoooosssstttt Unmap the window so that it is no longer displayed. If a lower-level cascaded menu is posted, unpost that menu. Returns an empty string. _p_a_t_h_N_a_m_e yyyyppppoooossssiiiittttiiiioooonnnn _i_n_d_e_x Returns a decimal string giving the y-coordinate within the menu window of the topmost pixel in the entry specified by _i_n_d_e_x. DDDDEEEEFFFFAAAAUUUULLLLTTTT BBBBIIIINNNNDDDDIIIINNNNGGGGSSSS Tk automatically creates class bindings for menus that give | them the following default behavior: | [1] || When the mouse cursor enters a menu, the entry | underneath the mouse cursor is activated; as the mouse | moves around the menu, the active entry changes to | track the mouse. | [2] || When button 1 is released over a menu, the active entry | (if any) is invoked. | [3] || A menu can be repositioned on the screen by dragging it | with mouse button 2. | [4] || A number of other bindings are created to support | keyboard menu traversal. See the manual entry for | ttttkkkk____bbbbiiiinnnnddddFFFFoooorrrrTTTTrrrraaaavvvveeeerrrrssssaaaallll for details on these bindings. | Disabled menu entries are non-responsive: they don't | activate and ignore mouse button presses and releases. | The behavior of menus can be changed by defining new | bindings for individual widgets or by redefining the class | bindings. Page 9 (printed 7/23/95) mmmmeeeennnnuuuu((((nnnn)))) TTTTkkkk (((( )))) mmmmeeeennnnuuuu((((nnnn)))) BBBBUUUUGGGGSSSS At present it isn't possible to use the option database to | specify values for the options to individual entries. KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS menu, widget Page 10 (printed 7/23/95) 
